Package | hl7.fhir.uv.crmi |
Type | OperationDefinition |
Id | Id |
FHIR Version | R4 |
Source | http://hl7.org/fhir/uv/crmi/https://build.fhir.org/ig/HL7/crmi-ig/OperationDefinition-get-package.html |
Url | http://hl7.org/fhir/uv/crmi/OperationDefinition/get-package |
Version | 1.1.0-cibuild |
Status | active |
Date | 2025-02-17T19:51:07+00:00 |
Name | GetPackage |
Title | Get Package |
Experimental | False |
Realm | uv |
Authority | hl7 |
Description | Retrieves a FHIR package given the package id and version. |
Type | false |
Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition get-package
URL: [base]/$get-package
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | id | 1..1 | string | The id of the package to retrieve. The server must know the package or be able to use a package feed to resolve the package id | ||
IN | version | 0..1 | string | The version of the library to be used for packaging. If a version is not specified, the latest version available to the server is returned. This value may also be the special values | ||
OUT | return | 1..1 | Binary | The requested package as a Binary resource. Note that servers may perform additional processing of the contents of the package to support target environments appropriate for their usage, so long as those modifications do not materially impact the contents of the package. |
This operation is used to retrieve a FHIR package
{
"resourceType" : "OperationDefinition",
"id" : "get-package",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition get-package</b></p><a name=\"get-package\"> </a><a name=\"hcget-package\"> </a><a name=\"get-package-en-US\"> </a><p>URL: [base]/$get-package</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The id of the package to retrieve. The server must know the package or be able to use a package feed to resolve the package id</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The version of the library to be used for packaging. If a version is not specified, the latest version available to the server is returned. This value may also be the special values <code>current</code>, indicating the current version for the package, and <code>dev</code>, indicating a pre-release version</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></td><td/><td><div><p>The requested package as a Binary resource. Note that servers may perform additional processing of the contents of the package to support target environments appropriate for their usage, so long as those modifications do not materially impact the contents of the package.</p>\n</div></td></tr></table><div><p>This operation is used to retrieve a FHIR package</p>\n</div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}
],
"url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/get-package",
"version" : "1.1.0-cibuild",
"name" : "GetPackage",
"title" : "Get Package",
"status" : "active",
"kind" : "operation",
"date" : "2025-02-17T19:51:07+00:00",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "Retrieves a FHIR package given the package id and version.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"code" : "get-package",
"comment" : "This operation is used to retrieve a FHIR package",
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [
{
"name" : "id",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The id of the package to retrieve. The server must know the package or be able to use a package feed to resolve the package id",
"type" : "string"
},
{
"name" : "version",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The version of the library to be used for packaging. If a version is not specified, the latest version available to the server is returned. This value may also be the special values `current`, indicating the current version for the package, and `dev`, indicating a pre-release version",
"type" : "string"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The requested package as a Binary resource. Note that servers may perform additional processing of the contents of the package to support target environments appropriate for their usage, so long as those modifications do not materially impact the contents of the package.",
"type" : "Binary"
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.